Vapi Metadata Metamodel OperationResultInfo

Vapi Metadata Metamodel OperationResultInfo

The Vapi Metadata Metamodel OperationResultInfo schema contains the metamodel information of an operation result element.

An operation accepts a list of parameters and returns a result or an error. The Vapi Metadata Metamodel OperationResultInfo describes the result element of an operation.

JSON Example

{
    "type": {
        "category": "string",
        "builtin_type": "string",
        "user_defined_type": {
            "resource_type": "string",
            "resource_id": "string"
        },
        "generic_instantiation": "Vapi Metadata Metamodel GenericInstantiation Object"
    },
    "metadata": {
        "metadata": {
            "elements": {
                "elements": {
                    "type": "string",
                    "long_value": 0,
                    "string_value": "string",
                    "list_value": [
                        "string"
                    ],
                    "structure_id": "string",
                    "structure_ids": [
                        "string"
                    ]
                }
            }
        }
    },
    "documentation": "string"
}

type

Required

Type information of the operation result element.

object

metadata

Required

Generic metadata elements for the service element. The key in the map is the name of the metadata element and the value is the data associated with that metadata element.

The Vapi Metadata Metamodel MetadataIdentifier contains possible string values for keys in the map.

string

documentation

Required

English language documentation for the operation result element. It can contain HTML markup and Javadoc tags.